CLI Tools, CLI for Steps 1-7 #88
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hollandjg
requested changes
Feb 5, 2024
Also, add some docstrings and doctests
…ep-2-b02_make_spectra_gft
So other steps can find input files
kmilo9999
reviewed
Feb 6, 2024
kmilo9999
previously approved these changes
Feb 6, 2024
Not meant to be used with cli with non-cli scripts
hollandjg
previously approved these changes
Feb 12, 2024
src/icesat2_tracks/clitools.py
Outdated
Comment on lines
12
to
22
| def suppress_stdout(verbose=False): | ||
| if verbose: | ||
| yield | ||
| else: | ||
| with open(os.devnull, "w") as devnull: | ||
| old_stdout = sys.stdout | ||
| sys.stdout = devnull | ||
| try: | ||
| yield | ||
| finally: | ||
| sys.stdout = old_stdout |
There was a problem hiding this comment.
There's a function provided in python 3.4+ which does this – please use that instead!
Check out https://stackoverflow.com/a/37989355/5542581:
import contextlib
with contextlib.redirect_stdout(None):
print("will not print")
print("this will print")There was a problem hiding this comment.
Interesting, thanks for the suggestion @hollandjg! I adapted the current implementation from a context manager that was available elsewhere in the repo.
It seems like contextlib.redirect_stdout is somewhat limited for this use case, however, as it doesn't have the flexibility to do conditional suppression. Can you think of a simple way to refactor the currently implemented suppress_stdout so that it leverages contextlib.redirect_stdout? I gave it some thought but couldn't come up with anything straightfoward.
Cli step 7 b06 correct
112 cli step 6 b04 define angle
95 cli step 5 b04 anglepy
…com/brown-ccv/icesat2-tracks into 93-cli-step-4-a02c_iowaga_thredds_priorpy
…ds_priorpy feat: cli step 4 a02c iowaga thredds prior
…ovpy feat: cli step 3 -- b03_plot_spectra_ovpy
…ep-2-b02_make_spectra_gft
feat: add cli to step 2 -- B02_make_spectra_gFT.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To facilitate reviewing #78, we are splitting it into bite-size chunks. This is the first one.
Changes:
Update: Dependencies and CI Runner for Step 1
Add
typerand others. The CI runner for Step 1 has also been updated to reflect these changes.Feature: CLI Tools for Step 1
CLI tools for the package and the particular cli for Step 1. It includes argument parsing and validation, and improved feedback output.